/*
 * Copyright (C) 2010-2011 Comcast Cable.  All Rights Reserved.
 */
package com.hercules.android.receiver.model.commands;

/**
 * <p>This is a subclass of XRECommand that represents a SHUTDOWN XRE command. It defines some properties specific to
 * this command. According to XRE protocol specification, this command is used for shutting down a connection. It is a
 * simple JavaBean (POJO) that provides getters and setters for all private attributes and performs no argument
 * validation in the setters.</p>
 *
 * <p><strong>Thread safety:</strong> This class is not thread safe because its base class is not thread safe.</p>
 *
 * @author saarixx, jmn
 * @version 1.0
 */
public class XREShutdownCommand extends XRECommand {

    /**
     * <p>The command name associated with this class.</p>
     *
     * <p>Immutable string constant.</p>
     *
     * <p>Is used in getCommand().</p>
     */
    public static final String COMMAND_NAME = "SHUTDOWN";

    /**
     * <p>Creates new instance of {@link XREShutdownCommand} class.</p>
     */
    public XREShutdownCommand() {
        // empty constructor
    }

    /**
     * <p>Retrieves the name of this command.</p>
     *
     * @return the name of this command
     */
    public String getCommand() {
        return COMMAND_NAME;
    }
}

